<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">

<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>/home/bernd/src/izot/shortstack/api/ShortStackIsiApi.c</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>

<!--  Generated by Natural Docs, version 1.52 -->
<!--  http://www.naturaldocs.org  -->

<!-- saved from url=(0026)http://www.naturaldocs.org -->




<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="ShortStackIsiApi.c"></a>ShortStackIsiApi.c</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#ShortStackIsiApi.c" >ShortStackIsiApi.c</a></td><td class=SDescription></td></tr><tr class="SGroup"><td class=SEntry><a href="#Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#IsiStop" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">IsiStop</a></td><td class=SDescription>Stops the ISI engine.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#IsiStart" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">IsiStart</a></td><td class=SDescription>Starts the ISI engine.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#IsiReturnToFactoryDefaults" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">IsiReturnToFactoryDefaults</a></td><td class=SDescription>Restores the device�s self-installation data to factory defaults.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#IsiAcquireDomain" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">IsiAcquireDomain</a></td><td class=SDescription>Starts or restarts the domain ID acquisition process in an ISI-DA device.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#IsiStartDeviceAcquisition" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">IsiStartDeviceAcquisition</a></td><td class=SDescription>Starts or retriggers device acquisition mode on a domain address server.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#IsiOpenEnrollment" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">IsiOpenEnrollment</a></td><td class=SDescription>Opens manual enrollment for the specified assembly.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#IsiCreateEnrollment" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">IsiCreateEnrollment</a></td><td class=SDescription>Accepts a connection invitation.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#IsiExtendEnrollment" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">IsiExtendEnrollment</a></td><td class=SDescription>Extends an enrollment invitation.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#IsiCancelEnrollment" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">IsiCancelEnrollment</a></td><td class=SDescription>Cancels an open (pending or approved) enrollment.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#IsiLeaveEnrollment" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">IsiLeaveEnrollment</a></td><td class=SDescription>Removes the specified assembly from all enrolled connections as a local operation only.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#IsiDeleteEnrollment" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">IsiDeleteEnrollment</a></td><td class=SDescription>Removes the specified assembly from all enrolled connections.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#IsiInitiateAutoEnrollment" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">IsiInitiateAutoEnrollment</a></td><td class=SDescription>Starts automatic enrollment.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#IsiQueryIsConnected" id=link13 onMouseOver="ShowTip(event, 'tt13', 'link13')" onMouseOut="HideTip('tt13')">IsiQueryIsConnected</a></td><td class=SDescription>Queries the connection status of an assembly.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#IsiQueryImplementationVersion" id=link14 onMouseOver="ShowTip(event, 'tt14', 'link14')" onMouseOut="HideTip('tt14')">IsiQueryImplementationVersion</a></td><td class=SDescription>Queries the version number of the ISI implementation.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#IsiQueryProtocolVersion" id=link15 onMouseOver="ShowTip(event, 'tt15', 'link15')" onMouseOut="HideTip('tt15')">IsiQueryProtocolVersion</a></td><td class=SDescription>Queries the protocol version of the ISI implementation.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#IsiQueryIsRunning" id=link16 onMouseOver="ShowTip(event, 'tt16', 'link16')" onMouseOut="HideTip('tt16')">IsiQueryIsRunning</a></td><td class=SDescription>Queries the state of the ISI engine.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#IsiQueryIsBecomingHost" id=link17 onMouseOver="ShowTip(event, 'tt17', 'link17')" onMouseOut="HideTip('tt17')">IsiQueryIsBecomingHost</a></td><td class=SDescription>Queries whether the specified assembly is a host for an enrollment.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#IsiCancelAcquisition" id=link18 onMouseOver="ShowTip(event, 'tt18', 'link18')" onMouseOut="HideTip('tt18')">IsiCancelAcquisition</a></td><td class=SDescription>Cancels both device and domain acquisition.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#IsiFetchDevice" id=link19 onMouseOver="ShowTip(event, 'tt19', 'link19')" onMouseOut="HideTip('tt19')">IsiFetchDevice</a></td><td class=SDescription>Fetches a device by assigning a domain to the device from a domain address server (DAS).</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#IsiFetchDomain" id=link20 onMouseOver="ShowTip(event, 'tt20', 'link20')" onMouseOut="HideTip('tt20')">IsiFetchDomain</a></td><td class=SDescription>Starts or restarts the fetch domain process in a domain address server (DAS).</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#IsiIssueHeartbeat" id=link21 onMouseOver="ShowTip(event, 'tt21', 'link21')" onMouseOut="HideTip('tt21')">IsiIssueHeartbeat</a></td><td class=SDescription>Sends an update for the specified bound output network variable and its aliases, using group addressing.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>

<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Functions"></a>Functions</h3></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiStop"></a>IsiStop</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiStop(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Stops the ISI engine.</p><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link22 onMouseOver="ShowTip(event, 'tt22', 'link22')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>Use the <a href="#IsiStart" class=LFunction id=link23 onMouseOver="ShowTip(event, 'tt2', 'link23')" onMouseOut="HideTip('tt2')">IsiStart</a> function to restart the ISI engine.&nbsp; This function has no forwarder.&nbsp; Calling this function when the ISI engine is already stopped has no action.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiStart"></a>IsiStart</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiStart(</td><td class="PType  prettyprint " nowrap>IsiType&nbsp;</td><td class="PParameter  prettyprint " nowrap>type,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>IsiStartFlags&nbsp;</td><td class="PParameter  prettyprint " nowrap>flags</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Starts the ISI engine.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>type</td><td class=CDLDescription>type of the ISI engine.</td></tr><tr><td class=CDLEntry>flags</td><td class=CDLDescription>option flags when starting the engine.</td></tr></table><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link24 onMouseOver="ShowTip(event, 'tt22', 'link24')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>After this function is called, the ISI engine sends and receives ISI messages, and manages the network configuration of your device.&nbsp; Typically, you start the ISI engine in your reset task when self-installation is enabled, and you stop the ISI engine when self-installation is disabled.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiReturnToFactoryDefaults"></a>IsiReturnToFactoryDefaults</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiReturnToFactoryDefaults(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Restores the device�s self-installation data to factory defaults.</p><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link25 onMouseOver="ShowTip(event, 'tt22', 'link25')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>This function restores the device�s self-installation data to factory defaults, causing the immediate and unrecoverable loss of all connection information.&nbsp; This function has the same functionality regardless of whether the ISI engine is running or not.&nbsp; The engine is stopped and the device resets to complete the process.&nbsp; Because of the reset, this function never returns to the caller.&nbsp; Any changes related to returning to factory defaults, such as resetting of device-specific configuration properties to their initial values, must occur prior to calling this function.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiAcquireDomain"></a>IsiAcquireDomain</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiAcquireDomain(</td><td class="PType  prettyprint " nowrap>LonBool&nbsp;</td><td class="PParameter  prettyprint " nowrap>sharedServicePin</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Starts or restarts the domain ID acquisition process in an ISI-DA device.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>sharedServicePin</td><td class=CDLDescription>boolean indicating whether the service pin is shared.</td></tr></table><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link26 onMouseOver="ShowTip(event, 'tt22', 'link26')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>This function is also used for the confirmation step in the domain ID acquisition and domain ID sniffing procedures.&nbsp; The ISI engine must be running for this function to have any effect.&nbsp; This function has unpredictable effect on an ISI-S device and therefore should only be used with an ISI-DA device.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiStartDeviceAcquisition"></a>IsiStartDeviceAcquisition</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiStartDeviceAcquisition(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Starts or retriggers device acquisition mode on a domain address server.</p><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link27 onMouseOver="ShowTip(event, 'tt22', 'link27')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>This function has no effect on an ISI-S or ISI-DA device, or if the ISI engine is stopped.&nbsp; No forwarder is provided for this function.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiOpenEnrollment"></a>IsiOpenEnrollment</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiOpenEnrollment(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>assembly</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Opens manual enrollment for the specified assembly.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>assembly</td><td class=CDLDescription>assembly for which the enrollment should be opened.</td></tr></table><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link28 onMouseOver="ShowTip(event, 'tt22', 'link28')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>This operation turns the device into a connection host for this connection, and sends a CSMO manual connection invitation to all devices in the network.&nbsp; No forwarder is provided for this function.&nbsp; The ISI engine must be running and in the idle state.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiCreateEnrollment"></a>IsiCreateEnrollment</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiCreateEnrollment(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>assembly</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Accepts a connection invitation.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>assembly</td><td class=CDLDescription>assembly for which the enrollment should be created.</td></tr></table><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link29 onMouseOver="ShowTip(event, 'tt22', 'link29')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>This function is called after the application has received and approved a CSMO open enrollment message.&nbsp; The connection is created anew, replacing any previously existing enrollment information associated with this assembly.&nbsp; On a connection host that has received at least one CSME enrollment acceptance message, this command completes the enrollment and implements the connection as new, replacing any previously existing enrollment information associated with this assembly.&nbsp; The ISI engine must be running and in the correct state for this function to have any effect.&nbsp; For a connection host, the ISI engine must be in the approved state.&nbsp; Other devices must be in the pending state.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiExtendEnrollment"></a>IsiExtendEnrollment</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiExtendEnrollment(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>assembly</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Extends an enrollment invitation.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>assembly</td><td class=CDLDescription>assembly for which the enrollment should be extended.</td></tr></table><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link30 onMouseOver="ShowTip(event, 'tt22', 'link30')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>This function is called after the application has received and approved a CSMO open enrollment message.&nbsp; The connection is added to any previously existing connections.&nbsp; If no previous connection exists for assembly, a new connection is created.&nbsp; On a connection host that has received at least one CSME enrollment acceptance message, this command completes the enrollment and extends any existing connections.&nbsp; If no previous connection exists for assembly, a new connection is created.&nbsp; The ISI engine must be running and in the correct state for this function to have any effect.&nbsp; For a connection host, the ISI engine must be in the approved state.&nbsp; Other devices must be in the pending state.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiCancelEnrollment"></a>IsiCancelEnrollment</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiCancelEnrollment(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Cancels an open (pending or approved) enrollment.</p><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link31 onMouseOver="ShowTip(event, 'tt22', 'link31')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>When used on a connection host, a CSMX connection cancellation message is issued to cancel enrollment on the connection members.&nbsp; When used on a device that has accepted, but not yet implemented, an open enrollment, this function causes the device to opt out of the enrollment locally.&nbsp; The function has no effect unless the ISI engine is running and in the pending or approved state.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiLeaveEnrollment"></a>IsiLeaveEnrollment</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiLeaveEnrollment(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>assembly</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes the specified assembly from all enrolled connections as a local operation only.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>assembly</td><td class=CDLDescription>assembly for which the enrollment should be removed.</td></tr></table><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link32 onMouseOver="ShowTip(event, 'tt22', 'link32')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>When used on the connection host, the function is automatically interpreted as <a href="#IsiDeleteEnrollment" class=LFunction id=link33 onMouseOver="ShowTip(event, 'tt11', 'link33')" onMouseOut="HideTip('tt11')">IsiDeleteEnrollment</a>.&nbsp; No forwarder is provided for this function.&nbsp; This function has no effect if the ISI engine is stopped.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiDeleteEnrollment"></a>IsiDeleteEnrollment</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiDeleteEnrollment(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>assembly</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes the specified assembly from all enrolled connections.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>assembly</td><td class=CDLDescription>assembly for which the enrollment should be deleted.</td></tr></table><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link34 onMouseOver="ShowTip(event, 'tt22', 'link34')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>This function removes the specified assembly from all enrolled connections, and sends a CSMD connection deletion message to all other devices in the connection to remove them from the connection as well.&nbsp; This function has no effect if the ISI engine is stopped.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiInitiateAutoEnrollment"></a>IsiInitiateAutoEnrollment</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiInitiateAutoEnrollment(</td><td class="PTypePrefix  prettyprint " nowrap>const&nbsp;</td><td class="PType  prettyprint " nowrap>IsiCsmoData&nbsp;</td><td class="PParameterPrefix  prettyprint " nowrap>*</td><td class="PParameter  prettyprint " nowrap>pCsma,</td></tr><tr><td></td><td class="PTypePrefix  prettyprint " nowrap></td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameterPrefix  prettyprint " nowrap></td><td class="PParameter  prettyprint " nowrap>Assembly</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Starts automatic enrollment.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>pCsma</td><td class=CDLDescription>data for automatic enrollment.</td></tr><tr><td class=CDLEntry>assembly</td><td class=CDLDescription>assembly for which the enrollment should be initiated.</td></tr></table><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link35 onMouseOver="ShowTip(event, 'tt22', 'link35')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>Use this function to start automatic enrollment.&nbsp; The local device becomes the host for the automatic connection.&nbsp; Automatic enrollment can replace previous connections, if any.&nbsp; No forwarder exists for this function.&nbsp; This function cannot be called before the <b>isiWarm</b> event has been signaled in the <a href="ShortStackIsiApi-h.html#IsiUpdateUserInterface" class=LFunction id=link36 onMouseOver="ShowTip(event, 'tt23', 'link36')" onMouseOut="HideTip('tt23')">IsiUpdateUserInterface</a> callback.&nbsp; This function does nothing when the ISI engine is stopped.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiQueryIsConnected"></a>IsiQueryIsConnected</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiQueryIsConnected(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>assembly</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Queries the connection status of an assembly.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>assembly</td><td class=CDLDescription>assembly for which the connection status needs to be queried.</td></tr></table><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link37 onMouseOver="ShowTip(event, 'tt22', 'link37')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>Successful invocation of this function results in the callback <a href="ShortStackIsiApi-h.html#IsiIsConnectedReceived" class=LFunction id=link38 onMouseOver="ShowTip(event, 'tt24', 'link38')" onMouseOut="HideTip('tt24')">IsiIsConnectedReceived</a>.&nbsp; The callback returns TRUE if the specified assembly is enrolled in a connection.&nbsp; No forwarder is provided for this function.&nbsp; The function operates whether the ISI engine is running or not.&nbsp; The callback returns FALSE if the ISI engine is stopped.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiQueryImplementationVersion"></a>IsiQueryImplementationVersion</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiQueryImplementationVersion(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Queries the version number of the ISI implementation.</p><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link39 onMouseOver="ShowTip(event, 'tt22', 'link39')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>Successful invocation of this function results in the callback <a href="ShortStackIsiApi-h.html#IsiImplementationVersionReceived" class=LFunction id=link40 onMouseOver="ShowTip(event, 'tt25', 'link40')" onMouseOut="HideTip('tt25')">IsiImplementationVersionReceived</a>.&nbsp; The callback returns the version number of the ISI implementation in the Micro Server.&nbsp; No forwarder is provided for this function.&nbsp; This function operates in any state of the ISI engine.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiQueryProtocolVersion"></a>IsiQueryProtocolVersion</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiQueryProtocolVersion(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Queries the protocol version of the ISI implementation.</p><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link41 onMouseOver="ShowTip(event, 'tt22', 'link41')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>Successful invocation of this function results in the callback <a href="ShortStackIsiApi-h.html#IsiProtocolVersionReceived" class=LFunction id=link42 onMouseOver="ShowTip(event, 'tt26', 'link42')" onMouseOut="HideTip('tt26')">IsiProtocolVersionReceived</a>.&nbsp; The callback returns the version of the ISI protocol supported by the ISI engine.&nbsp; The number indicates the maximum protocol version supported.&nbsp; The ISI engine also supports protocol versions less than the number returned unless explicitly indicated.&nbsp; No forwarder is provided for this function.&nbsp; The function operates in either state of the ISI engine.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiQueryIsRunning"></a>IsiQueryIsRunning</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiQueryIsRunning(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Queries the state of the ISI engine.</p><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link43 onMouseOver="ShowTip(event, 'tt22', 'link43')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>Successful invocation of this function results in the callback <a href="ShortStackIsiApi-h.html#IsiIsRunningReceived" class=LFunction id=link44 onMouseOver="ShowTip(event, 'tt27', 'link44')" onMouseOut="HideTip('tt27')">IsiIsRunningReceived</a>.&nbsp; The callback returns TRUE if the ISI engine is running and FALSE if the ISI engine is stopped.&nbsp; Non-zero values are considered TRUE.&nbsp; No forwarder is provided for this function.&nbsp; The function operates in all states of the ISI engine.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiQueryIsBecomingHost"></a>IsiQueryIsBecomingHost</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiQueryIsBecomingHost(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>assembly</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Queries whether the specified assembly is a host for an enrollment.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>assembly</td><td class=CDLDescription>assembly which needs to be queried.</td></tr></table><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link45 onMouseOver="ShowTip(event, 'tt22', 'link45')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>Successful invocation of this function results in the callback <a href="ShortStackIsiApi-h.html#IsiIsBecomingHostReceived" class=LFunction id=link46 onMouseOver="ShowTip(event, 'tt28', 'link46')" onMouseOut="HideTip('tt28')">IsiIsBecomingHostReceived</a>.&nbsp; The callback returns TRUE if <a href="#IsiOpenEnrollment" class=LFunction id=link47 onMouseOver="ShowTip(event, 'tt6', 'link47')" onMouseOut="HideTip('tt6')">IsiOpenEnrollment</a> has been called for the specified assembly and the enrollment has not yet timed out, been cancelled, or confirmed.&nbsp; The function returns FALSE otherwise.&nbsp; You can also override the <a href="ShortStackIsiApi-h.html#IsiUpdateUserInterface" class=LFunction id=link48 onMouseOver="ShowTip(event, 'tt23', 'link48')" onMouseOut="HideTip('tt23')">IsiUpdateUserInterface</a> callback function and track the state of the assembly.&nbsp; The callack returns TRUE if that state is <b>IsiPendingHost</b> or <b>IsiApprovedHost</b>.&nbsp; No forwarder is provided for this function.&nbsp; The function operates whether the ISI engine is running or not.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiCancelAcquisition"></a>IsiCancelAcquisition</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiCancelAcquisition(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Cancels both device and domain acquisition.</p><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link49 onMouseOver="ShowTip(event, 'tt22', 'link49')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>Following the completion of this function call, <a href="ShortStackIsiApi-h.html#IsiUpdateUserInterface" class=LFunction id=link50 onMouseOver="ShowTip(event, 'tt23', 'link50')" onMouseOut="HideTip('tt23')">IsiUpdateUserInterface</a> is called with the <b>IsiNormal</b> event.&nbsp; This function has no effect unless the ISI engine is running and the device is either in device or domain acquisition mode.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiFetchDevice"></a>IsiFetchDevice</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiFetchDevice(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Fetches a device by assigning a domain to the device from a domain address server (DAS).</p><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link51 onMouseOver="ShowTip(event, 'tt22', 'link51')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>This function must not be called from a device that is not a domain address server.&nbsp; This operation does not require application code on the remote device.&nbsp; The remote device remains unaware of the change to its primary domain.&nbsp; An alternate method to assign a domain to a device is for the device to use the <a href="#IsiAcquireDomain" class=LFunction id=link52 onMouseOver="ShowTip(event, 'tt4', 'link52')" onMouseOut="HideTip('tt4')">IsiAcquireDomain</a> function.&nbsp; This function provides more immediate recovery from network addressing conflicts and more immediate maintenance of automatic connections.&nbsp; The disadvantage of using the <a href="#IsiAcquireDomain" class=LFunction id=link53 onMouseOver="ShowTip(event, 'tt4', 'link53')" onMouseOut="HideTip('tt4')">IsiAcquireDomain</a> function is that it typically requires more code on the device, and it requires that the device support ISI-DA.&nbsp; The <a href="#IsiFetchDevice" class=LFunction id=link54 onMouseOver="ShowTip(event, 'tt19', 'link54')" onMouseOut="HideTip('tt19')">IsiFetchDevice</a> function can be used with any device.&nbsp; A DAS must support both methods.&nbsp; The ISI engine must be running for this function to have any effect, and this function only operates on a domain address server.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiFetchDomain"></a>IsiFetchDomain</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiFetchDomain(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Starts or restarts the fetch domain process in a domain address server (DAS).</p><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link55 onMouseOver="ShowTip(event, 'tt22', 'link55')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>This function must not be called from a device that is not a domain address server.&nbsp; The ISI engine must be running for this function to have any effect, and this function only operates on a domain address server.</p></div></div></div>

<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="IsiIssueHeartbeat"></a>IsiIssueHeartbeat</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiIssueHeartbeat(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>index</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sends an update for the specified bound output network variable and its aliases, using group addressing.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>index</td><td class=CDLDescription>network variable index for which the heart beat needs to be issued.</td></tr></table><h4 class=CHeading>Returns</h4><p><a href="ShortStackTypes-h.html#LonApiError" class=LType id=link56 onMouseOver="ShowTip(event, 'tt22', 'link56')" onMouseOut="HideTip('tt22')">LonApiError</a>.</p><h4 class=CHeading>Remarks</h4><p>This function sends a network variable update for the specified network variable index and its aliases, as long as the network variable is a bound output network variable using group addressing.&nbsp; This function uses the address table for addressing information, but always uses unacknowledged service with one repeat when issuing the heartbeat.&nbsp; It only sends a network variable if it uses group addressing (the default ISI addressing mode) � it skips updates that use a different addressing mode.&nbsp; This function is typically called in an <a href="ShortStackIsiApi-h.html#IsiQueryHeartbeat" class=LFunction id=link57 onMouseOver="ShowTip(event, 'tt29', 'link57')" onMouseOut="HideTip('tt29')">IsiQueryHeartbeat</a> callback.&nbsp; If the function is called outside of this callback to create a custom heartbeat scheme, the application must only call this function for bound output network variables.&nbsp; This function requires that the ISI engine has been started with the <b>IsiFlagHeartbeat</b> flag.</p></div></div></div>

</div><!--Content-->


<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->


<div id=Menu><div class=MEntry><div class=MFile><a href="ldv-h.html">ldv.h</a></div></div><div class=MEntry><div class=MFile><a href="LonPlatform-h.html">LonPlatform.h</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackApi-h.html">SHORTSTACK API</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackIsiApi-h.html">SHORTSTACK ISI API</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackIsiTypes-h.html">SHORTSTACK ISI TYPES</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackTypes-h.html">SHORTSTACK TYPES</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackApi-c.html">ShortStackApi.c</a></div></div><div class=MEntry><div class=MFile><a href="ShortStackHandlers-c.html">ShortStackHandlers.c</a></div></div><div class=MEntry><div class=MFile id=MSelected>ShortStackIsiApi.c</div></div><div class=MEntry><div class=MFile><a href="ShortStackIsiHandlers-c.html">ShortStackIsiHandlers.c</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Index</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MIndex><a href="../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Macros.html">Macros</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Types.html">Types</a></div></div></div></div></div><script type="text/javascript"><!--
var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option  id=MSearchEverything selected value="General">Everything</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Macros">Macros</option><option value="Types">Types</option></select></div></div><!--Menu-->



<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiStop(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Stops the ISI engine.</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiStart(</td><td class="PType  prettyprint " nowrap>IsiType&nbsp;</td><td class="PParameter  prettyprint " nowrap>type,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>IsiStartFlags&nbsp;</td><td class="PParameter  prettyprint " nowrap>flags</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Starts the ISI engine.</div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiReturnToFactoryDefaults(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Restores the device�s self-installation data to factory defaults.</div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiAcquireDomain(</td><td class="PType  prettyprint " nowrap>LonBool&nbsp;</td><td class="PParameter  prettyprint " nowrap>sharedServicePin</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Starts or restarts the domain ID acquisition process in an ISI-DA device.</div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiStartDeviceAcquisition(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Starts or retriggers device acquisition mode on a domain address server.</div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiOpenEnrollment(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>assembly</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Opens manual enrollment for the specified assembly.</div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiCreateEnrollment(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>assembly</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Accepts a connection invitation.</div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiExtendEnrollment(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>assembly</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Extends an enrollment invitation.</div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiCancelEnrollment(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Cancels an open (pending or approved) enrollment.</div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiLeaveEnrollment(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>assembly</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Removes the specified assembly from all enrolled connections as a local operation only.</div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiDeleteEnrollment(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>assembly</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Removes the specified assembly from all enrolled connections.</div></div><div class=CToolTip id="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiInitiateAutoEnrollment(</td><td class="PTypePrefix  prettyprint " nowrap>const&nbsp;</td><td class="PType  prettyprint " nowrap>IsiCsmoData&nbsp;</td><td class="PParameterPrefix  prettyprint " nowrap>*</td><td class="PParameter  prettyprint " nowrap>pCsma,</td></tr><tr><td></td><td class="PTypePrefix  prettyprint " nowrap></td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameterPrefix  prettyprint " nowrap></td><td class="PParameter  prettyprint " nowrap>Assembly</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Starts automatic enrollment.</div></div><div class=CToolTip id="tt13"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiQueryIsConnected(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>assembly</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Queries the connection status of an assembly.</div></div><div class=CToolTip id="tt14"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiQueryImplementationVersion(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Queries the version number of the ISI implementation.</div></div><div class=CToolTip id="tt15"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiQueryProtocolVersion(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Queries the protocol version of the ISI implementation.</div></div><div class=CToolTip id="tt16"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiQueryIsRunning(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Queries the state of the ISI engine.</div></div><div class=CToolTip id="tt17"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiQueryIsBecomingHost(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>assembly</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Queries whether the specified assembly is a host for an enrollment.</div></div><div class=CToolTip id="tt18"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiCancelAcquisition(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Cancels both device and domain acquisition.</div></div><div class=CToolTip id="tt19"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiFetchDevice(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Fetches a device by assigning a domain to the device from a domain address server (DAS).</div></div><div class=CToolTip id="tt20"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiFetchDomain(</td><td class="PParameter  prettyprint " nowrap>void</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Starts or restarts the fetch domain process in a domain address server (DAS).</div></div><div class=CToolTip id="tt21"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>const LonApiError IsiIssueHeartbeat(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>index</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Sends an update for the specified bound output network variable and its aliases, using group addressing.</div></div><div class=CToolTip id="tt22"><div class=CType>ShortStack LonTalk Compact 2.1 API error codes.</div></div><div class=CToolTip id="tt23"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>extern void IsiUpdateUserInterface(</td><td class="PType  prettyprint " nowrap>IsiEvent&nbsp;</td><td class="PParameter  prettyprint " nowrap>event,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>parameter</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Provides status feedback from the ISI engine.</div></div><div class=CToolTip id="tt24"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>extern void IsiIsConnectedReceived(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>assembly,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>LonBool&nbsp;</td><td class="PParameter  prettyprint " nowrap>isConnected</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Occurs when the response to IsiQueryIsConnected is received.</div></div><div class=CToolTip id="tt25"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>extern void IsiImplementationVersionReceived(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>version</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Occurs when the response to IsiQueryImplementationVersion is received.</div></div><div class=CToolTip id="tt26"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>extern void IsiProtocolVersionReceived(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>version</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Occurs when the response to IsiQueryProtocolVersion is received.</div></div><div class=CToolTip id="tt27"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>extern void IsiIsRunningReceived(</td><td class="PType  prettyprint " nowrap>LonBool&nbsp;</td><td class="PParameter  prettyprint " nowrap>isRunning</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Occurs when the response to IsiQueryIsRunning is received.</div></div><div class=CToolTip id="tt28"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>extern void IsiIsBecomingHostReceived(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>assembly,</td></tr><tr><td></td><td class="PType  prettyprint " nowrap>LonBool&nbsp;</td><td class="PParameter  prettyprint " nowrap>isBecomingHost</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Occurs when the response to IsiQueryIsBecomingHost is received.</div></div><div class=CToolTip id="tt29"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters  prettyprint "nowrap>extern LonBool IsiQueryHeartbeat(</td><td class="PType  prettyprint " nowrap>unsigned&nbsp;</td><td class="PParameter  prettyprint " nowrap>nvIndex</td><td class="PAfterParameters  prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Returns TRUE if a heartbeat for the network variable with the global index nvIndex has been sent, and returns FALSE otherwise.</div></div><!--END_ND_TOOLTIPS-->




<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>


<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>